VMAIL

Section: User Commands (1)
Updated: 30 September 1987
Index Return to Main Contents
 

NAME

vmail - tty interface to MH  

SYNOPSIS

vmail [-ans] [-burst] [-comp] [-dist] [-flush] [-forw] [-inc] [-sort] [+cur_folder] folders ...  

DESCRIPTION

vmail is a tty interface to the MH mail system. It combines most of the MH features into a single package, and performs the most frequently-used functions considerably faster than the MH equivalents. In particular, a folder is only scanned once in a vmail session; the slow scan-show-rmm-scan cycle of MH is eliminated. Also, vmail tends to be simpler for new users to learn than the MH system.  

STARTING UP

When vmail is invoked, it loads mail headers for the folders which will initially be active. The default is for inbox (or the MH profile field Current-Folder) to be the only active folder. (Other folders may be made active during the course of a session.) There are a number of command-line flags. -inc asks vmail to incorporate mail before loading any folders. -flush instructs vmail not to flush typeahead. -comp, -forw, -ans, -dist, -burst, and -sort specify that comp, forw, repl (`answer'), dist, burst, and sortm respectively do not require that the user give arguments; see the commands c, f, a, t, b, and S. Arguments may also be set by the profile component vmail. Typical usage of vmail might be:

       vmail +priv inbox outbox

to start up vmail with folders priv, inbox, and outbox active and with priv as the current folder. vmail might then print

        Vmail 9/87 -- reading mail headers
                inbox: 122-279 (32 items)
                outbox: 1-95 (19 items)
                priv: 2-19 (5 items)

as it loaded the named folders. When loading completed it would bring up the screen representing the mail items in the folder priv.
     priv (page 1 of 1)

        2  17-06-86  fred@munnari    Just testing << Are you receiving
        6   7-11-86  To: fred, nerk  A promise << The commitment: Dinn
        7   9-05-87  bill            thanks for everything, but << wha
       12  11-05-87 -bill            Re: thanks for everything, but <<
       19   9-05-87  To: bill        Re: thanks for everything, but <<

(Note that the dates in the example are in British format; a US installation would have the US form.) The `-' indicates that a reply has been sent to that piece of mail. Text to the left of `<<' is the subject, other text is the first part of the body. The user could now move up and down between mail items with k and j, show the current mail item with <space>, delete the current mail item with d, or forward or answer it with f or a.

If the folder priv contained more mail items than could be displayed on a screen, priv would be broken into a number of pages. vmail has one or more pages for each active folder. The user can move between pages, which are ordered alphabetically on folder name, by typing <return> and <backspace> (forwards and backwards respectively).  

THE DETAILS

For those who like to mix use of MH and vmail, vmail updates the MH environment on q (quit), ! (call shell) and ^Z (suspend). Specifically, the fields `Current-Folder' in context and `cur' in mh-profile are updated to be the current folder and current mail item respectively. Also, the ^R command is useful for getting vmail to sync up and recognize changes made by mh commands not under its control.

The following points are relevant to all vmail commands. First, type-ahead is flushed (as in rn), so any commands typed ahead of time will be ignored. Second, vmail always remembers the name of an ``alternate folder'', the last folder other than the current folder with which there has been an interaction (such as the folder to which an item was refiled, or the previous current folder). This alternate folder is used by a number of commands. Third, some commands may be preceded by a count.

The following is a complete list of vmail commands.

<space>
Show current mail item (like show).
<return>
Go to next active page of mail headers (uses count).
<backspace>
Go to previous active page of mail headers (uses count).
^,$
Go to the first (or last) active page of mail headers.
/,?
Search forwards (or backwards) through mail headers for the given regular expression. /<return> will repeat search forwards, ?<return> will repeat the search backwards. It is not possible to backspace over / or ?; use interrupt instead.
.
Re-execute last command (if one of acdDefirR). (On repeat, r will not prompt for a folder name.)
^L
Refresh screen.
^R
Refresh list of items for this folder. This rebuilds the vmail data structures. ^R is useful for resyncing the item listing with changes made by MH commands not performed by vmail itself.
|
Pipe current mail item into command.
!
Invoke your favourite shell (csh by default).
a
Answer current mail item (call to repl). vmail will ask for arguments unless -ans has been set. vmail data structures won't be updated.
b
Burst a mail item (call to burst). This splits a digest or a message carrying several forwarded messages into individual messages. vmail will ask for arguments unless -burst has been set. vmail data structures will be updated.
c
Compose new mail (call to comp). vmail will ask for arguments unless -comp has been set. vmail data structures won't be updated.
C
Invoke the folder chooser. This is a screen which permits users to select a current folder by moving the cursor to a folder name with vi movement keys and hitting <space>.
d
Delete current mail item (uses count) (like rmm). Actually, the mail item is moved from maildir/folder/num to maildir/folder/#num. vi users beware, dd deletes two items of mail.
D
Delete current mail item, show next.
e
Edit current mail item.
f
Forward current mail item (call to forw). vmail will ask for arguments unless -forw has been set. vmail data structures won't be updated.
g,G
Go to the named (or go to alternate) folder.
F
Show all foldernames.
h
Display the help screen.
H
Go to top of page (or as offset by count).
i
Incorporate mail (call to inc). vmail data structures are updated.
j
Move cursor down (uses count). At the bottom of the page, j will go to the top of the next page of the current folder.
k
Move cursor up (uses count). At the top of the page, k will go to the bottom of the previous page of the current folder.
L
Go to bottom of page (or as offset by count).
M
Go to middle of page.
n
Go to the next folder, making it active if it is not so already (uses count).
p
Go to the previous folder, making it active if it is not so already (uses count).
P
Print the name of the alternate folder.
q
Exit.
r
Refile current item into the named folder.
R
Refile current item into the last folder to which something was refiled.
s
Save current mail item in the named file. Most filename expansions are not recognized, but `~/' and `~user/' are replaced by the appropriate paths.
S
Sort the current folder (call to sortm). This sorts all the messages in the current folder in order of the Date: lines. vmail will ask for arguments unless -sort has been set. vmail data structures will be updated.
t
Distribute an existing mail item to new recipients (call to dist). vmail will ask for arguments unless -dist has been set. vmail data structures won't be updated.
u
Undo most recent deletion.
v
Make the current folder inactive.
z
Pack the current folder.

The commands a, c, t and f update the physical folders, but the corresponding pages of mail headers in vmail are not updated. ^R can be used to force the vmail representation of a folder to come up to date.

vmail recognizes the following environment variables. Where they describe an executable, a full path name should be given.

SHELL
Subshell invoked on `!'. Default is /bin/csh.
PAGER
Default is /usr/ucb/more.
EDITOR
Used for editing stored mail. The default is /usr/ucb/vi.
MH
Used to identify the MH profile. From the profile, vmail recognizes Path, Msg-protect and Folder-protect. The calls to MH utilities use the MH profile as appropriate. The default is ~/.mh_profile.
 

PROFILE ENTRIES

Folder-Protect (protection for new folders)

Path (of mail directory)

Current-Folder (for startup folder)

Vmail (list of arguments)  

FILES

$HOME/.mh_profile

$HOME/Mail

$HOME/Mail/context  

SEE ALSO

burst(1), comp(1), dist(1), forw(1), inc(1), repl(1), sortm(1).  

HISTORY

Original program Copyright 1987 J. Zobel, jz@mulga.oz.au. Permission for redistribution and modifications were permitted, providing that the copyright notice remained intact.

Bug fixes, Sparc port, burst, dist, resync commands added by James Perkins 1989-1991, jamesp@metolius.wr.tek.com.  

BUGS

Check the alternate folder before using it unless absolutely sure of its identity; a command may change it unexpectedly.

Only a couple of formats of "Date:" lines are recognized; if the format is different, the date is replaced by a block of spaces.

Startup time is proportional to the number of items in the current folder. It is therefore better to have a large number of folders each with fewer mail items than a small number of large folders. Many first-time vmail users find that their inbox is large enough (> 400 items, say) that vmail takes a while to start up - expect to spend some time initially decluttering inbox and other large folders.

If your inbox is empty at startup, vmail will immediately exit.


 

Index

NAME
SYNOPSIS
DESCRIPTION
STARTING UP
THE DETAILS
PROFILE ENTRIES
FILES
SEE ALSO
HISTORY
BUGS

This document was created by man2html, using the manual pages.
Time: 04:07:43 GMT, January 16, 2023